<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>RequestUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/entitybus/util/request/RequestUtils.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: RequestUtils.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-utils/xref/org/sakaiproject/entitybus/util/request/RequestUtils.html $</em>
<a name="4" href="#4">4</a>   <em> * RequestUtils.java - entity-broker - Jul 28, 2008 7:41:28 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.util.request;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.IOException;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.HashSet;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Map;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Map.Entry;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <strong>import</strong> javax.servlet.RequestDispatcher;
<a name="29" href="#29">29</a>  <strong>import</strong> javax.servlet.ServletException;
<a name="30" href="#30">30</a>  <strong>import</strong> javax.servlet.http.HttpServletRequest;
<a name="31" href="#31">31</a>  <strong>import</strong> javax.servlet.http.HttpServletResponse;
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="35" href="#35">35</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityView;
<a name="36" href="#36">36</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.Formats;
<a name="37" href="#37">37</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestStorage;
<a name="38" href="#38">38</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.search.Order;
<a name="39" href="#39">39</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.search.Restriction;
<a name="40" href="#40">40</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.search.Search;
<a name="41" href="#41">41</a>  <strong>import</strong> org.sakaiproject.entitybus.exception.EntityException;
<a name="42" href="#42">42</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityRequestHandler;
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>  <em>/**<em>*</em></em>
<a name="46" href="#46">46</a>  <em> * Contains a set of static utility methods for working with requests</em>
<a name="47" href="#47">47</a>  <em> * </em>
<a name="48" href="#48">48</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="49" href="#49">49</a>  <em> */</em>
<a name="50" href="#50">50</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/entitybus/util/request/RequestUtils.html">RequestUtils</a> {
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String DIVIDER = <span class="string">"||"</span>;
<a name="53" href="#53">53</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String ENTITY_REDIRECT_CHECK = <span class="string">"_entityRedirectCheck"</span>;
<a name="54" href="#54">54</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(RequestUtils.<strong>class</strong>);
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>      <em>/**<em>*</em></em>
<a name="57" href="#57">57</a>  <em>     * Handles the redirect to a URL from the current location,</em>
<a name="58" href="#58">58</a>  <em>     * the URL should be relative for a forward, otherwise it will be a redirect &lt;br/></em>
<a name="59" href="#59">59</a>  <em>     * NOTE: You should perform no actions after call this method,</em>
<a name="60" href="#60">60</a>  <em>     * you should simply pass control back to the handler</em>
<a name="61" href="#61">61</a>  <em>     * @param redirectURL the URL to redirect to (relative or absolute)</em>
<a name="62" href="#62">62</a>  <em>     * @param forward if false, use redirect (this should be the default), </em>
<a name="63" href="#63">63</a>  <em>     * if true use forward, note that we can only forward from your webapp back to your servlets and</em>
<a name="64" href="#64">64</a>  <em>     * a check will be performed to see if this is the case, if it is not</em>
<a name="65" href="#65">65</a>  <em>     * (anything with a "http", a non-matching prefix, and anything with a query string) will be switched to redirect automatically</em>
<a name="66" href="#66">66</a>  <em>     * @param req the current request</em>
<a name="67" href="#67">67</a>  <em>     * @param res the current response</em>
<a name="68" href="#68">68</a>  <em>     * @throws IllegalArgumentException is the params are invalid</em>
<a name="69" href="#69">69</a>  <em>     */</em>
<a name="70" href="#70">70</a>      <strong>public</strong> <strong>static</strong> <strong>void</strong> handleURLRedirect(String redirectURL, <strong>boolean</strong> forward, HttpServletRequest req, HttpServletResponse res) {
<a name="71" href="#71">71</a>          <strong>if</strong> (redirectURL == <strong>null</strong> || <span class="string">""</span>.equals(redirectURL)) {
<a name="72" href="#72">72</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"The redirect URL must be set and cannot be null"</span>);
<a name="73" href="#73">73</a>          }
<a name="74" href="#74">74</a>          <strong>if</strong> (req == <strong>null</strong> || res == <strong>null</strong>) {
<a name="75" href="#75">75</a>              <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"The request and response must be set and cannot be null"</span>);         
<a name="76" href="#76">76</a>          }
<a name="77" href="#77">77</a>          <strong>if</strong> (redirectURL.startsWith(<span class="string">"http:"</span>) || redirectURL.startsWith(<span class="string">"https:"</span>) 
<a name="78" href="#78">78</a>                  || RequestUtils.containsQueryString(redirectURL)) {
<a name="79" href="#79">79</a>              forward = false;
<a name="80" href="#80">80</a>          } <strong>else</strong> {
<a name="81" href="#81">81</a>              <em class="comment">// we allow forwarding ONLY if the current webapp path matches the redirect path</em>
<a name="82" href="#82">82</a>              String webapp = req.getContextPath();
<a name="83" href="#83">83</a>              <strong>if</strong> (webapp != <strong>null</strong> &amp;&amp; webapp.length() > 0) {
<a name="84" href="#84">84</a>                  <strong>if</strong> (redirectURL.startsWith(webapp + <span class="string">"/"</span>)) {
<a name="85" href="#85">85</a>                      redirectURL = redirectURL.substring(webapp.length());
<a name="86" href="#86">86</a>                      forward = <strong>true</strong>;
<a name="87" href="#87">87</a>                  } <strong>else</strong> <strong>if</strong> (redirectURL.length() > 1 
<a name="88" href="#88">88</a>                          &amp;&amp; redirectURL.startsWith(webapp.substring(1) + <span class="string">"/"</span>)) {
<a name="89" href="#89">89</a>                      redirectURL = redirectURL.substring(webapp.length() - 1);
<a name="90" href="#90">90</a>                      forward = <strong>true</strong>;
<a name="91" href="#91">91</a>                  } <strong>else</strong> {
<a name="92" href="#92">92</a>                      forward = false;
<a name="93" href="#93">93</a>                  }
<a name="94" href="#94">94</a>              }
<a name="95" href="#95">95</a>          }
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>          <strong>if</strong> (forward) {
<a name="98" href="#98">98</a>              <em class="comment">// check for infinite forwarding</em>
<a name="99" href="#99">99</a>              String curRedirect = DIVIDER + redirectURL + DIVIDER;
<a name="100" href="#100">100</a>             <strong>if</strong> (req.getAttribute(ENTITY_REDIRECT_CHECK) != <strong>null</strong>) {
<a name="101" href="#101">101</a>                 String redirectCheck = (String) req.getAttribute(ENTITY_REDIRECT_CHECK);
<a name="102" href="#102">102</a>                 <strong>if</strong> (redirectCheck.contains(curRedirect)) {
<a name="103" href="#103">103</a>                     <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Infinite forwarding loop detected with attempted redirect to ("</span>+redirectURL+<span class="string">"), path to failure: "</span> 
<a name="104" href="#104">104</a>                             + redirectCheck.replace(DIVIDER+DIVIDER, <span class="string">" => "</span>).replace(DIVIDER, <span class="string">""</span>) + <span class="string">" => "</span> + redirectURL);
<a name="105" href="#105">105</a>                 }
<a name="106" href="#106">106</a>                 redirectCheck += curRedirect;
<a name="107" href="#107">107</a>                 req.setAttribute(ENTITY_REDIRECT_CHECK, redirectCheck);
<a name="108" href="#108">108</a>             } <strong>else</strong> {
<a name="109" href="#109">109</a>                 req.setAttribute(ENTITY_REDIRECT_CHECK, curRedirect);
<a name="110" href="#110">110</a>             }
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>             RequestDispatcher rd = req.getRequestDispatcher(redirectURL);
<a name="113" href="#113">113</a>             <strong>try</strong> {
<a name="114" href="#114">114</a>                 rd.forward(req, res);
<a name="115" href="#115">115</a>             } <strong>catch</strong> (ServletException e) {
<a name="116" href="#116">116</a>                 <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failure with servlet while forwarding to '"</span>+redirectURL+<span class="string">"': "</span> + e.getMessage(), e);
<a name="117" href="#117">117</a>             } <strong>catch</strong> (IOException e) {
<a name="118" href="#118">118</a>                 <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failure with encoding while forwarding to '"</span>+redirectURL+<span class="string">"': "</span> + e.getMessage(), e);
<a name="119" href="#119">119</a>             }
<a name="120" href="#120">120</a>         } <strong>else</strong> {
<a name="121" href="#121">121</a>             res.setStatus(HttpServletResponse.SC_MOVED_TEMPORARILY);
<a name="122" href="#122">122</a>             <strong>try</strong> {
<a name="123" href="#123">123</a>                 res.sendRedirect(redirectURL);
<a name="124" href="#124">124</a>             } <strong>catch</strong> (IOException e) {
<a name="125" href="#125">125</a>                 <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failure with encoding while redirecting to '"</span>+redirectURL+<span class="string">"': "</span> + e.getMessage(), e);
<a name="126" href="#126">126</a>             }
<a name="127" href="#127">127</a>         }
<a name="128" href="#128">128</a>     }
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>     <em>/**<em>*</em></em>
<a name="131" href="#131">131</a> <em>     * Simple check to see if a URL appears to contain a query string,</em>
<a name="132" href="#132">132</a> <em>     * true if it does, false otherwise</em>
<a name="133" href="#133">133</a> <em>     */</em>
<a name="134" href="#134">134</a>     <strong>private</strong> <strong>static</strong> <strong>boolean</strong> containsQueryString(String URL) {
<a name="135" href="#135">135</a>         <strong>int</strong> lastEquals = URL.lastIndexOf('=');
<a name="136" href="#136">136</a>         <strong>int</strong> qMark = URL.indexOf('?');
<a name="137" href="#137">137</a>         <strong>if</strong> (lastEquals > 0 &amp;&amp; qMark > 0 &amp;&amp; lastEquals > qMark) {
<a name="138" href="#138">138</a>             <strong>return</strong> <strong>true</strong>;
<a name="139" href="#139">139</a>         }
<a name="140" href="#140">140</a>         <strong>return</strong> false;
<a name="141" href="#141">141</a>     }
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a>     <em>/**<em>*</em></em>
<a name="144" href="#144">144</a> <em>     * Gets the correct info out of the request method and places it into the entity view and</em>
<a name="145" href="#145">145</a> <em>     * identifies if this is an output (read) or input (write) request</em>
<a name="146" href="#146">146</a> <em>     * @param req the request</em>
<a name="147" href="#147">147</a> <em>     * @param view the entity view to update</em>
<a name="148" href="#148">148</a> <em>     * @return true if output request OR false if input request</em>
<a name="149" href="#149">149</a> <em>     * @throws EntityException if the request has problems</em>
<a name="150" href="#150">150</a> <em>     */</em>
<a name="151" href="#151">151</a>     <strong>public</strong> <strong>static</strong> <strong>boolean</strong> isRequestOutput(HttpServletRequest req, EntityView view) {
<a name="152" href="#152">152</a>         <strong>boolean</strong> output = false;
<a name="153" href="#153">153</a>         String method = req.getMethod() == <strong>null</strong> ? EntityView.Method.GET.name() : req.getMethod().toUpperCase().trim();
<a name="154" href="#154">154</a>         <strong>if</strong> (EntityView.Method.GET.name().equals(method)) {
<a name="155" href="#155">155</a>             view.setMethod(EntityView.Method.GET);
<a name="156" href="#156">156</a>             output = <strong>true</strong>;
<a name="157" href="#157">157</a>         } <strong>else</strong> <strong>if</strong> (EntityView.Method.HEAD.name().equals(method)) {
<a name="158" href="#158">158</a>             view.setMethod(EntityView.Method.HEAD);
<a name="159" href="#159">159</a>             output = <strong>true</strong>;
<a name="160" href="#160">160</a>         } <strong>else</strong> {
<a name="161" href="#161">161</a>             <em class="comment">// identify the action based on the method type or "_method" attribute</em>
<a name="162" href="#162">162</a>             <strong>if</strong> (EntityView.Method.DELETE.name().equals(method)) {
<a name="163" href="#163">163</a>                 view.setViewKey(EntityView.VIEW_DELETE);
<a name="164" href="#164">164</a>                 view.setMethod(EntityView.Method.DELETE);
<a name="165" href="#165">165</a>             } <strong>else</strong> <strong>if</strong> (EntityView.Method.PUT.name().equals(method)) {
<a name="166" href="#166">166</a>                 view.setViewKey(EntityView.VIEW_EDIT);
<a name="167" href="#167">167</a>                 view.setMethod(EntityView.Method.PUT);
<a name="168" href="#168">168</a>             } <strong>else</strong> <strong>if</strong> (EntityView.Method.POST.name().equals(method)) {
<a name="169" href="#169">169</a>                 String _method = req.getParameter(EntityRequestHandler.COMPENSATE_METHOD);
<a name="170" href="#170">170</a>                 <strong>if</strong> (_method == <strong>null</strong>) {
<a name="171" href="#171">171</a>                     <strong>if</strong> (view.getEntityReference().getId() == <strong>null</strong>) {
<a name="172" href="#172">172</a>                         <em class="comment">// this better be a create request or list post</em>
<a name="173" href="#173">173</a>                         view.setViewKey(EntityView.VIEW_NEW);
<a name="174" href="#174">174</a>                     } <strong>else</strong> {
<a name="175" href="#175">175</a>                         <em class="comment">// this could be an edit</em>
<a name="176" href="#176">176</a>                         view.setViewKey(EntityView.VIEW_EDIT);
<a name="177" href="#177">177</a>                     }
<a name="178" href="#178">178</a>                 } <strong>else</strong> {
<a name="179" href="#179">179</a>                     _method = _method.toUpperCase().trim();
<a name="180" href="#180">180</a>                     <strong>if</strong> (EntityView.Method.DELETE.name().equals(_method)) {
<a name="181" href="#181">181</a>                         view.setViewKey(EntityView.VIEW_DELETE);
<a name="182" href="#182">182</a>                     } <strong>else</strong> <strong>if</strong> (EntityView.Method.PUT.name().equals(_method)) {
<a name="183" href="#183">183</a>                         <strong>if</strong> (view.getEntityReference().getId() == <strong>null</strong>) {
<a name="184" href="#184">184</a>                             <em class="comment">// this should be a modification of a list</em>
<a name="185" href="#185">185</a>                             view.setViewKey(EntityView.VIEW_NEW);
<a name="186" href="#186">186</a>                         } <strong>else</strong> {
<a name="187" href="#187">187</a>                             <em class="comment">// this better be an edit of an entity</em>
<a name="188" href="#188">188</a>                             view.setViewKey(EntityView.VIEW_EDIT);
<a name="189" href="#189">189</a>                         }
<a name="190" href="#190">190</a>                     } <strong>else</strong> {
<a name="191" href="#191">191</a>                         <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Unable to handle POST request with _method, unknown method (only PUT/DELETE allowed): "</span> + _method, 
<a name="192" href="#192">192</a>                                 view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST);                        
<a name="193" href="#193">193</a>                     }
<a name="194" href="#194">194</a>                 }
<a name="195" href="#195">195</a>                 view.setMethod(EntityView.Method.POST);
<a name="196" href="#196">196</a>             } <strong>else</strong> {
<a name="197" href="#197">197</a>                 <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Unable to handle request method, unknown method (only GET/POST/PUT/DELETE allowed): "</span> + method, 
<a name="198" href="#198">198</a>                         view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST);
<a name="199" href="#199">199</a>             }
<a name="200" href="#200">200</a> 
<a name="201" href="#201">201</a>             <em class="comment">// check that the request is valid (delete requires an entity id)</em>
<a name="202" href="#202">202</a>             <strong>if</strong> ( EntityView.VIEW_DELETE.equals(view.getViewKey()) 
<a name="203" href="#203">203</a>                     &amp;&amp; view.getEntityReference().getId() == <strong>null</strong>) {
<a name="204" href="#204">204</a>                 <strong>throw</strong> <strong>new</strong> EntityException(<span class="string">"Unable to handle entity ("</span>+view.getEntityReference()+<span class="string">") delete request without entity id, url="</span> 
<a name="205" href="#205">205</a>                         + view.getOriginalEntityUrl(), 
<a name="206" href="#206">206</a>                         view.getEntityReference()+<span class="string">""</span>, HttpServletResponse.SC_BAD_REQUEST);
<a name="207" href="#207">207</a>             }
<a name="208" href="#208">208</a>         }
<a name="209" href="#209">209</a>         <strong>return</strong> output;
<a name="210" href="#210">210</a>     }
<a name="211" href="#211">211</a> 
<a name="212" href="#212">212</a>     <em class="comment">// put the keys which should be ignored in this array which will be placed in a set and ignored</em>
<a name="213" href="#213">213</a>     <strong>public</strong> <strong>static</strong> String[] ignoreForSearch = <strong>new</strong> String[] {
<a name="214" href="#214">214</a>         EntityRequestHandler.COMPENSATE_METHOD,
<a name="215" href="#215">215</a>         <span class="string">"queryString"</span>, 
<a name="216" href="#216">216</a>         <span class="string">"pathInfo"</span>, 
<a name="217" href="#217">217</a>         <span class="string">"method"</span>, 
<a name="218" href="#218">218</a>         RequestStorage.ReservedKeys._locale.name(),
<a name="219" href="#219">219</a>         RequestStorage.ReservedKeys._requestActive.name(),
<a name="220" href="#220">220</a>         RequestStorage.ReservedKeys._requestEntityReference.name(),
<a name="221" href="#221">221</a>         RequestStorage.ReservedKeys._requestOrigin.name(),
<a name="222" href="#222">222</a>         <span class="string">"entity-format"</span>
<a name="223" href="#223">223</a>     };
<a name="224" href="#224">224</a>     <strong>private</strong> <strong>static</strong> HashSet&lt;String> ignoreSet = <strong>null</strong>;
<a name="225" href="#225">225</a>     <strong>private</strong> <strong>static</strong> <strong>synchronized</strong> HashSet&lt;String> getIgnoreSet() {
<a name="226" href="#226">226</a>         <strong>if</strong> (ignoreSet == <strong>null</strong>) {
<a name="227" href="#227">227</a>             <em class="comment">// load the array into a set for easier and faster checks</em>
<a name="228" href="#228">228</a>             ignoreSet = <strong>new</strong> HashSet&lt;String>();
<a name="229" href="#229">229</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; ignoreForSearch.length; i++) {
<a name="230" href="#230">230</a>                 ignoreSet.add(ignoreForSearch[i]);
<a name="231" href="#231">231</a>             }
<a name="232" href="#232">232</a>         }
<a name="233" href="#233">233</a>         <strong>return</strong> ignoreSet;
<a name="234" href="#234">234</a>     }
<a name="235" href="#235">235</a> 
<a name="236" href="#236">236</a>     <em>/**<em>*</em></em>
<a name="237" href="#237">237</a> <em>     * This looks at request parameters and returns anything it finds in the</em>
<a name="238" href="#238">238</a> <em>     * request parameters that can be put into the search,</em>
<a name="239" href="#239">239</a> <em>     * supports the page params and sorting params</em>
<a name="240" href="#240">240</a> <em>     * </em>
<a name="241" href="#241">241</a> <em>     * @param params the request params from a request (do not include headers)</em>
<a name="242" href="#242">242</a> <em>     * @return a search filter object</em>
<a name="243" href="#243">243</a> <em>     */</em>
<a name="244" href="#244">244</a>     <strong>public</strong> <strong>static</strong> Search makeSearchFromRequestParams(Map&lt;String, Object> params) {
<a name="245" href="#245">245</a>         Search search = <strong>new</strong> Search();
<a name="246" href="#246">246</a>         <strong>int</strong> page = -1;
<a name="247" href="#247">247</a>         <strong>int</strong> limit = -1;
<a name="248" href="#248">248</a>         <strong>try</strong> {
<a name="249" href="#249">249</a>             <strong>if</strong> (params != <strong>null</strong>) {
<a name="250" href="#250">250</a>                 <strong>for</strong> (Entry&lt;String, Object> entry : params.entrySet()) {
<a name="251" href="#251">251</a>                     String key = entry.getKey();
<a name="252" href="#252">252</a>                     <em class="comment">// filter out certain keys</em>
<a name="253" href="#253">253</a>                     <strong>if</strong> (getIgnoreSet().contains(key)) {
<a name="254" href="#254">254</a>                         <strong>continue</strong>; <em class="comment">// skip this key</em>
<a name="255" href="#255">255</a>                     }
<a name="256" href="#256">256</a>                     Object value = entry.getValue();
<a name="257" href="#257">257</a>                     <strong>if</strong> (value == <strong>null</strong>) {
<a name="258" href="#258">258</a>                         <em class="comment">// in theory this should not happen</em>
<a name="259" href="#259">259</a>                         <strong>continue</strong>;
<a name="260" href="#260">260</a>                     } <strong>else</strong> <strong>if</strong> (value.getClass().isArray()) {
<a name="261" href="#261">261</a>                         <em class="comment">// use the value as is</em>
<a name="262" href="#262">262</a>                     } <strong>else</strong> {
<a name="263" href="#263">263</a>                         <em class="comment">// get paging values out if possible</em>
<a name="264" href="#264">264</a>                         <strong>if</strong> (<span class="string">"_limit"</span>.equals(key) 
<a name="265" href="#265">265</a>                                 || <span class="string">"_perpage"</span>.equals(key)
<a name="266" href="#266">266</a>                                 || <span class="string">"perpage"</span>.equals(key)
<a name="267" href="#267">267</a>                                 || <span class="string">"count"</span>.equals(key)
<a name="268" href="#268">268</a>                                 || <span class="string">"itemsPerPage"</span>.equals(key)) {
<a name="269" href="#269">269</a>                             <strong>try</strong> {
<a name="270" href="#270">270</a>                                 limit = Integer.valueOf(value.toString()).intValue();
<a name="271" href="#271">271</a>                                 search.setLimit(limit);
<a name="272" href="#272">272</a>                             } <strong>catch</strong> (NumberFormatException e) {
<a name="273" href="#273">273</a>                                 log.warn(<span class="string">"Invalid non-number passed in for _limit/_perpage param: "</span> + value, e);
<a name="274" href="#274">274</a>                             }
<a name="275" href="#275">275</a>                             <strong>continue</strong>;
<a name="276" href="#276">276</a>                         } <strong>else</strong> <strong>if</strong> (<span class="string">"_start"</span>.equals(key)
<a name="277" href="#277">277</a>                                 || <span class="string">"startIndex"</span>.equals(key)) {
<a name="278" href="#278">278</a>                             <strong>try</strong> {
<a name="279" href="#279">279</a>                                 <strong>int</strong> start = Integer.valueOf(value.toString()).<strong>int</strong>Value();
<a name="280" href="#280">280</a>                                 search.setStart(start);
<a name="281" href="#281">281</a>                             } <strong>catch</strong> (NumberFormatException e) {
<a name="282" href="#282">282</a>                                 log.warn(<span class="string">"Invalid non-number passed in for '_start' param: "</span> + value, e);
<a name="283" href="#283">283</a>                             }
<a name="284" href="#284">284</a>                             <strong>continue</strong>;
<a name="285" href="#285">285</a>                         } <strong>else</strong> <strong>if</strong> (<span class="string">"_page"</span>.equals(key)
<a name="286" href="#286">286</a>                                 || <span class="string">"page"</span>.equals(key)
<a name="287" href="#287">287</a>                                 || <span class="string">"startPage"</span>.equals(key)) {
<a name="288" href="#288">288</a>                             <strong>try</strong> {
<a name="289" href="#289">289</a>                                 page = Integer.valueOf(value.toString()).intValue();
<a name="290" href="#290">290</a>                             } <strong>catch</strong> (NumberFormatException e) {
<a name="291" href="#291">291</a>                                 log.warn(<span class="string">"Invalid non-number passed in for '_page' param: "</span> + value, e);
<a name="292" href="#292">292</a>                             }
<a name="293" href="#293">293</a>                             <strong>continue</strong>;
<a name="294" href="#294">294</a>                         } <strong>else</strong> <strong>if</strong> (<span class="string">"_order"</span>.equals(key)
<a name="295" href="#295">295</a>                                 || <span class="string">"_sort"</span>.equals(key)
<a name="296" href="#296">296</a>                                 || <span class="string">"sort"</span>.equals(key)) {
<a name="297" href="#297">297</a>                             <strong>if</strong> (value != <strong>null</strong>) {
<a name="298" href="#298">298</a>                                 String val = value.toString();
<a name="299" href="#299">299</a>                                 String[] sortBy = <strong>new</strong> String[] {val};
<a name="300" href="#300">300</a>                                 <strong>if</strong> (val.indexOf(',') > 0) {
<a name="301" href="#301">301</a>                                     <em class="comment">// multiple sort params</em>
<a name="302" href="#302">302</a>                                     sortBy = val.split(<span class="string">","</span>);
<a name="303" href="#303">303</a>                                 }
<a name="304" href="#304">304</a>                                 <strong>try</strong> {
<a name="305" href="#305">305</a>                                     <strong>for</strong> (<strong>int</strong> i = 0; i &lt; sortBy.length; i++) {
<a name="306" href="#306">306</a>                                         String sortItem = sortBy[i].trim();
<a name="307" href="#307">307</a>                                         <strong>if</strong> (sortItem.endsWith(<span class="string">"_reverse"</span>)) {
<a name="308" href="#308">308</a>                                             search.addOrder( <strong>new</strong> Order(sortItem.substring(0, sortItem.length()-8), false) );
<a name="309" href="#309">309</a>                                         } <strong>else</strong> <strong>if</strong> (sortItem.endsWith(<span class="string">"_desc"</span>)) {
<a name="310" href="#310">310</a>                                             search.addOrder( <strong>new</strong> Order(sortItem.substring(0, sortItem.length()-5), false) );
<a name="311" href="#311">311</a>                                         } <strong>else</strong> <strong>if</strong> (sortItem.endsWith(<span class="string">"_asc"</span>)) {
<a name="312" href="#312">312</a>                                             search.addOrder( <strong>new</strong> Order(sortItem.substring(0, sortItem.length()-4)) );
<a name="313" href="#313">313</a>                                         } <strong>else</strong> {
<a name="314" href="#314">314</a>                                             search.addOrder( <strong>new</strong> Order(sortItem) );
<a name="315" href="#315">315</a>                                         }
<a name="316" href="#316">316</a>                                     }
<a name="317" href="#317">317</a>                                 } <strong>catch</strong> (RuntimeException e) {
<a name="318" href="#318">318</a>                                     log.warn(<span class="string">"Failed while getting the sort/order param: "</span> + val, e);
<a name="319" href="#319">319</a>                                 }
<a name="320" href="#320">320</a>                             }
<a name="321" href="#321">321</a>                             <strong>continue</strong>;
<a name="322" href="#322">322</a>                         } <strong>else</strong> <strong>if</strong> (<span class="string">"_searchTerms"</span>.equals(key) 
<a name="323" href="#323">323</a>                                 || <span class="string">"searchTerms"</span>.equals(key)) {
<a name="324" href="#324">324</a>                             <em class="comment">// indicates a space delimited list of search terms</em>
<a name="325" href="#325">325</a>                             <strong>if</strong> (value != <strong>null</strong>) {
<a name="326" href="#326">326</a>                                 String val = value.toString();
<a name="327" href="#327">327</a>                                 String[] terms = val.split(<span class="string">" "</span>);
<a name="328" href="#328">328</a>                                 search.addRestriction( <strong>new</strong> Restriction(<span class="string">"searchTerms"</span>, terms) );
<a name="329" href="#329">329</a>                             }
<a name="330" href="#330">330</a>                             <strong>continue</strong>;
<a name="331" href="#331">331</a>                         }
<a name="332" href="#332">332</a>                     }
<a name="333" href="#333">333</a>                     search.addRestriction( <strong>new</strong> Restriction(key, value) );
<a name="334" href="#334">334</a>                 }
<a name="335" href="#335">335</a>             }
<a name="336" href="#336">336</a>         } <strong>catch</strong> (Exception e) {
<a name="337" href="#337">337</a>             <em class="comment">// failed to translate the request to a search, not really much to do here</em>
<a name="338" href="#338">338</a>             log.warn(<span class="string">"Could not translate entity request into search params: "</span> + e.getMessage(), e);
<a name="339" href="#339">339</a>         }
<a name="340" href="#340">340</a>         <em class="comment">// translate page into start/limit</em>
<a name="341" href="#341">341</a>         <strong>if</strong> (page > 0) {
<a name="342" href="#342">342</a>             <strong>if</strong> (limit &lt;= -1) {
<a name="343" href="#343">343</a>                 limit = 10; <em class="comment">// set to a default value</em>
<a name="344" href="#344">344</a>                 search.setLimit(limit);
<a name="345" href="#345">345</a>                 log.warn(<span class="string">"page is set without a limit per page, setting per page limit to default value of 10"</span>);
<a name="346" href="#346">346</a>             }
<a name="347" href="#347">347</a>             search.setStart( (page-1) * limit );
<a name="348" href="#348">348</a>         }
<a name="349" href="#349">349</a>         <strong>return</strong> search;
<a name="350" href="#350">350</a>     }
<a name="351" href="#351">351</a> 
<a name="352" href="#352">352</a>     <em>/**<em>*</em></em>
<a name="353" href="#353">353</a> <em>     * This will set the response mime type correctly based on the format constant,</em>
<a name="354" href="#354">354</a> <em>     * also sets the response encoding to UTF_8</em>
<a name="355" href="#355">355</a> <em>     * @param format the format constant, example {@link Formats#XML}</em>
<a name="356" href="#356">356</a> <em>     * @param res the current outgoing response</em>
<a name="357" href="#357">357</a> <em>     */</em>
<a name="358" href="#358">358</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> setResponseEncoding(String format, HttpServletResponse res) {
<a name="359" href="#359">359</a>         String encoding;
<a name="360" href="#360">360</a>         <strong>if</strong> (Formats.XML.equals(format)) {
<a name="361" href="#361">361</a>             encoding = Formats.XML_MIME_TYPE;
<a name="362" href="#362">362</a>         } <strong>else</strong> <strong>if</strong> (Formats.HTML.equals(format)) {
<a name="363" href="#363">363</a>             encoding = Formats.HTML_MIME_TYPE;
<a name="364" href="#364">364</a>         } <strong>else</strong> <strong>if</strong> (Formats.JSON.equals(format)) {
<a name="365" href="#365">365</a>             encoding = Formats.JSON_MIME_TYPE;
<a name="366" href="#366">366</a>         } <strong>else</strong> <strong>if</strong> (Formats.RSS.equals(format)) {
<a name="367" href="#367">367</a>             encoding = Formats.RSS_MIME_TYPE;                        
<a name="368" href="#368">368</a>         } <strong>else</strong> <strong>if</strong> (Formats.ATOM.equals(format)) {
<a name="369" href="#369">369</a>             encoding = Formats.ATOM_MIME_TYPE;                        
<a name="370" href="#370">370</a>         } <strong>else</strong> {
<a name="371" href="#371">371</a>             encoding = Formats.TXT_MIME_TYPE;
<a name="372" href="#372">372</a>         }
<a name="373" href="#373">373</a>         res.setContentType(encoding);
<a name="374" href="#374">374</a>         res.setCharacterEncoding(Formats.UTF_8);
<a name="375" href="#375">375</a>     }
<a name="376" href="#376">376</a> 
<a name="377" href="#377">377</a>     <em>/**<em>*</em></em>
<a name="378" href="#378">378</a> <em>     * This finds the correct servlet path or returns the default one,</em>
<a name="379" href="#379">379</a> <em>     * will not return "" or null</em>
<a name="380" href="#380">380</a> <em>     * @param req the incoming request</em>
<a name="381" href="#381">381</a> <em>     * @return the servlet context path (/ + servletName)</em>
<a name="382" href="#382">382</a> <em>     */</em>
<a name="383" href="#383">383</a>     <strong>public</strong> <strong>static</strong> String getServletContext(HttpServletRequest req) {
<a name="384" href="#384">384</a>         String context = <strong>null</strong>;
<a name="385" href="#385">385</a>         <strong>if</strong> (req != <strong>null</strong>) {
<a name="386" href="#386">386</a>             context = req.getContextPath();
<a name="387" href="#387">387</a>             <strong>if</strong> (<span class="string">""</span>.equals(context)) {
<a name="388" href="#388">388</a>                 context = req.getServletPath();
<a name="389" href="#389">389</a>             }
<a name="390" href="#390">390</a>         }
<a name="391" href="#391">391</a>         <strong>if</strong> (context == <strong>null</strong> || <span class="string">""</span>.equals(context)) {
<a name="392" href="#392">392</a>             context = EntityView.DIRECT_PREFIX;
<a name="393" href="#393">393</a>         }
<a name="394" href="#394">394</a>         <strong>return</strong> context;
<a name="395" href="#395">395</a>     }
<a name="396" href="#396">396</a> 
<a name="397" href="#397">397</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

